WIP update Stan to lvl6 #1

iskelic · 2021-03-29T09:43:29Z

Description:

Updating PHPStan to lvl6

ghost · 2022-03-22T05:26:39Z

@penovic @iskelic I tried this one out, phpstan is all green, is there any further work on this one, perhaps adding psalm?

phpstan.neon

ghost · 2023-10-25T11:53:05Z

src/Definition/Encoding/DocumentToPhpArrayEncoderInterface.php

+    /**
+     * @return array<string,mixed>
+     *
+     * @psalm-suppress PossiblyUnusedMethod


@mplesa1 this method is used inside the project, how come Psalm recognizes it as unused?

Used inside tests

ghost · 2023-10-25T11:54:56Z

src/Definition/Encoding/PhpArrayToRelationshipCollectionEncoderInterface.php

+     *
+     * @throws JsonApiEncodingException
+     *
+     * @psalm-suppress PossiblyUnusedMethod


Used inside tests?

Even though it's used, Psalm recognizes it as unused?

I removed the annotation because it's also used inside PhpArrayToRelationshipCollectionEncoder. But yes, if it's only used inside some test we need annotation.

src/Definition/Encoding/PhpArrayToRelationshipCollectionEncoderInterface.php

src/Definition/Exception/Request/UnsupportedFilterAttributeGivenException.php

src/Definition/Model/Request/CreateResourceRequestInterface.php

src/Definition/Model/Request/ResourcePayloadRequest.php

src/Definition/Model/Request/UpdateResourceRequestInterface.php

src/Implementation/Encoding/PhpArrayToAttributeCollectionEncoder.php

src/Implementation/Encoding/PhpArrayToResourceEncoder.php

src/Implementation/Model/Link/LinkCollection.php

mplesa1 · 2023-10-25T14:37:28Z

@penovic @iskelic I tried this one out, phpstan is all green, is there any further work on this one, perhaps adding psalm?

psalm is added

ghost · 2023-10-26T07:37:48Z

src/Definition/Model/Request/ResourcePayloadRequest.php

@@ -6,7 +6,9 @@

 use Undabot\JsonApi\Definition\Model\Resource\ResourceInterface;

+/** @psalm-suppress UnusedClass */


Psalm documentation says the following:

If this class is used and part of the public API, annotate it with @psalm-api.

I believe we should check all of the classes that are used as part of json-api-symfony and mark them with @psalm-api instead of suppressing the error.

good catch, I replace it

ghost · 2023-10-26T07:39:15Z

src/Implementation/Encoding/PhpArrayToResourceEncoder.php

-        $rawMeta = $resource['meta'] ?? null;
-        $rawLink = $resource['links']['self'] ?? null;
+
+        $rawAttributes = $this->assertStringKeyArray($resource['attributes'] ?? []);


What do you think about adding a string $key to this method, resulting in the coalescing operator being moved to the assertStringKeyArray method to avoid doing it outside on each call to the method?

agree, good catch, I refactored both assertStringKeyArray and assertStringKeyArrayNested

ghost · 2023-10-26T07:41:23Z

src/Implementation/Encoding/PhpArrayToResourceEncoder.php

+    private function assertStringKeyArray(mixed $array): array
+    {
+        if (!is_array($array)) {
+            throw new \InvalidArgumentException("Parameter is not array.");
+        }
+        foreach ($array as $key) {
+            if (!is_string($key)) {
+                throw new \InvalidArgumentException("Array key must be a string.");
+            }
+        }
+
+        return $array;
+
+    }
+
+    /**
+     *
+     * @param mixed $array
+     * @return array<string, array<string, mixed>>
+     */
+    function assertStringKeyArrayNested(mixed $array): array


These methods could be moved to some sort of a utility class if we're going to need them in more places?

Yes, I move them to the existing abstract class ArrayUtil

ghost · 2023-10-26T07:42:09Z

src/Implementation/Model/Request/Sort/SortSet.php

+/**
+ * @implements IteratorAggregate<int,Sort>
+ */
+class SortSet implements \IteratorAggregate
 {
    /** @var Sort[] */
    private $sorts;


ghost · 2023-10-26T07:42:26Z

src/Implementation/Model/Resource/Attribute/AttributeCollection.php

 class AttributeCollection implements AttributeCollectionInterface
 {
-    /** @var Attribute[] */
+    /** @var AttributeInterface[] */
    private $attributes;


ghost · 2023-10-26T07:43:21Z

src/Implementation/Model/Resource/Relationship/RelationshipCollection.php

 use Undabot\JsonApi\Definition\Model\Resource\Relationship\RelationshipCollectionInterface;
 use Undabot\JsonApi\Definition\Model\Resource\Relationship\RelationshipInterface;

 class RelationshipCollection implements RelationshipCollectionInterface
 {
-    /** @var array */
+    /** @var RelationshipInterface[] */
    private $relationships = [];


ghost · 2023-10-26T07:43:57Z

src/Implementation/Model/Resource/ResourceCollection.php

+            //            $message = sprintf('ResourceIdentifierInterface expected, %s given', \get_class($resourceIdentifier));
+            //
+            //            throw new InvalidArgumentException($message);


Why is this commented out?

I don't know, @KondukterCRO did those changes in this branch d05ac8b#diff-390909c32070ee11ae2baba70ca5c9e766a3b2bf1a3a2297dd63ddde7a79f4db Pena, do you have some information?

ghost · 2023-10-26T07:50:29Z

src/Implementation/Model/Resource/ResourceIdentifierCollection.php

+            //            $message = sprintf('ResourceIdentifierInterface expected, %s given', \get_class($resourceIdentifier));
+            //
+            //            throw new InvalidArgumentException($message);


Same question as before

@KondukterCRO same question as before

…nEncoderInterface

…ny interfaces

…th adding key param and handle null

…ons to ArrayUtil

iskelic · 2023-10-31T10:12:57Z

src/Definition/Encoding/LinkToPhpArrayEncoderInterface.php

@@ -8,5 +8,8 @@

 interface LinkToPhpArrayEncoderInterface
 {
+    /**
+     * @return null|array<string,mixed>|string


iskelic requested a review from penovic March 29, 2021 09:43

iskelic self-assigned this Mar 29, 2021

Moirae and others added 5 commits February 9, 2022 13:24

refactor: update stan to lvl6

6fdd67c

refactor: update phpstan to max level

d05ac8b

refactor: wip phpstan

6ecfb5a

fix: phpstan errors

498f568

fix: qc

c5870e3

KondukterCRO force-pushed the refactor/update-phpstan branch from 8b1baff to c5870e3 Compare February 9, 2022 17:18

KondukterCRO changed the base branch from master to develop May 3, 2023 12:26

Marko Plesa added 5 commits October 13, 2023 08:46

feat: update php stan packages and phpcsfixer

db94609

fix: php-cs-fixer fix

5050b77

fix: php stan errors

2b33661

fix: psalm errors

2eba25f

fix: extra errors on stan and psalm, fix tests

06fe610

ghost requested review from a user and KondukterCRO and removed request for penovic October 25, 2023 11:43

ghost reviewed Oct 25, 2023

View reviewed changes

phpstan.neon Outdated Show resolved Hide resolved

ghost suggested changes Oct 25, 2023

View reviewed changes

Marko Plesa added 2 commits October 25, 2023 16:13

fix: remove redundant anotation

9cdc9c1

fix: redudant contructor UnusedMethod

3fcfed7

Marko Plesa added 2 commits October 25, 2023 17:41

fix: restore deleted files, fix stan and psalm errors

db5b746

fix: add property type in LinkCollection

f19533c

ghost suggested changes Oct 26, 2023

View reviewed changes

Marko Plesa added 4 commits October 26, 2023 11:36

fix: remove PossiblyUnusedMethod from PhpArrayToRelationshipCollectio…

ae738e2

…nEncoderInterface

fix: replace unused class wit psalm-api annotation for json-api-symfo…

f66e161

…ny interfaces

feat: reafctor assertStringKeyArray and assertStringKeyArrayNested wi…

2c19ccf

…th adding key param and handle null

feat: move assertStringKeyArray and assertStringKeyArrayNested functi…

6d347f9

…ons to ArrayUtil

fix: add missing array property type

fc479cb

iskelic commented Oct 31, 2023

View reviewed changes

fix: php-cs-fixer fix

8323b92

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP update Stan to lvl6 #1

WIP update Stan to lvl6 #1

iskelic commented Mar 29, 2021

ghost commented Mar 22, 2022

ghost Oct 25, 2023

mplesa1 Oct 25, 2023

ghost Oct 25, 2023

mplesa1 Oct 25, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

mplesa1 commented Oct 25, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

ghost Oct 26, 2023

mplesa1 Oct 26, 2023

iskelic Oct 31, 2023

		@@ -6,7 +6,9 @@

		use Undabot\JsonApi\Definition\Model\Resource\ResourceInterface;

		/** @psalm-suppress UnusedClass */

WIP update Stan to lvl6 #1

Are you sure you want to change the base?

WIP update Stan to lvl6 #1

Conversation

iskelic commented Mar 29, 2021

ghost commented Mar 22, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mplesa1 commented Oct 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment